home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / pcvile.zip / VILE.HLP < prev   
Text File  |  1991-07-21  |  28KB  |  634 lines
  1. Welcome to pcvile
  2. -----------------
  3.     This version of vile differs from the distributed source code of
  4.     vile version 3 in a few ways which I shall make clear here:
  5.  
  6.     1) The cursor keys, page up/down and insert/delete keys have been
  7.        compiled into the program (I tried binding but due to a bug this
  8.        didn't seem to work too well) so this should keep the "I don't
  9.        like using hjkl" brigade happy!
  10.  
  11.     2) Vile distinguishes between a write of a region ':1,20w' and a
  12.        write of a whole file ':w' and so each of these have been given
  13.        different letters.  The region write is ':1,20W' and the file
  14.        write remains ':w'.  ':wq' remains the same.
  15.  
  16.     3) I have implemented the emacs ^X-O command to flip between windows
  17.        as I tend to use this quite a bit rather then ^N and ^P which is
  18.        the vile standard.
  19.  
  20.     4) You can force this version of vile into one of three screen modes:
  21.        25, 43 and 50 line.  I have had problems with the 43 line mode
  22.        on AST premium 286 workstations (the only EGA I can lay my hands on)
  23.        so I apologise if it doesn't work, the 25 and 50 line modes work
  24.        fine though.  The default is 50 lines (for various reasons!) so if
  25.        you have a mono or cga monitor you'll have to change your vile.rc
  26.        file.
  27.  
  28.        There are two ways to set the screen mode:
  29.  
  30.        a) with a command line option: -2 -4 -5 are 25, 43 and 50 line resp.
  31.  
  32.        b) by adding "setg screen {25|43|50}" into your vile.rc file.
  33.           Note you should NOT do this from within the editor.
  34.  
  35.        Also, if you shell out in 50 line mode, make sure you are in 50 line
  36.        mode before you exit the dos shell, otherwise you end up with a 50
  37.        line edit window with only the top 25 displayed!
  38.  
  39.        Personally I find 50 line mode very usable, but I know people who
  40.        have difficulty reading it so just put setg screen 25 in the vile.rc
  41.        file to save your eyesight.
  42.  
  43.     5) Shelling out to dos can be done by using ^Z, however this doesn't
  44.        seem to want to work if vile has run out of memory.
  45.  
  46.     There are still plenty of bugs I know, the main one I want to get done
  47.     first being memory, ie running out, and the vi compatibility isn't
  48.     100% but I like it, and I hope some others might too.
  49.  
  50.     I am taking responsibility for any pcvile bugs (please check the enclosed
  51.     known bug list first though) and I'll then split them into pc
  52.     specific, which I will deal with, and vile general bugs, which I will pass
  53.     on to Paul Fox so that they can be fixed for version 4.
  54.  
  55.  
  56. Getting along with vile
  57. -----------------------
  58.     Use Ctrl-D and Ctrl-U to scroll through this help information.
  59.  
  60.     Type Ctrl-O to make this the only window on the screen.
  61.  
  62.     The only vile commands described herein are those not 
  63.     present in vi, or differing greatly from those in vi.
  64.     There is a section at the bottom describing other differences
  65.     between vile and vi.
  66.  
  67.     First, to leave vile, use any of the following:
  68.         :q
  69.         :quit
  70.         :exit
  71.         :wq    (writes the file before quitting)
  72.         :q!    (quits without writing changes!)
  73.         Q
  74.         ZZ    (will write all unwritten buffers)
  75.         ^X-^C    (don't know why.  _They_ don't put in ":q" for _us_!)
  76.  
  77.     To get help (probably just this text), use any of:
  78.         :h
  79.         :help
  80.         ^X-^H
  81.         ^A-^H
  82.  
  83. General Remarks
  84. ---------------
  85.     Vile holds text in "buffers".  Usually, these correspond to a file
  86.     that you are editing, but not always.  For instance, a buffer
  87.     might be used to display this help text, or to hold the output
  88.     of a shell command that you have run.  Buffers have names, and
  89.     these usually match the names of the files they contain.
  90.  
  91.     Buffers are sometimes displayed in windows.  A buffer may be 
  92.     displayed in more than one window at the same time.  There is 
  93.     no such thing as a hidden window.  All existing windows are on 
  94.     the screen.  There may, however, be hidden buffers, which are not 
  95.     currently associated with any window.
  96.  
  97.     All yank/delete registers (the default unnamed register, the numbered
  98.     registers ("1-"9) that hold line-deletes, and the named registers
  99.     ("a-"z)) are global to the editor, and not attached to any single
  100.     buffer.  Thus you can delete text in one buffer and put it back in
  101.     another. 
  102.  
  103.     Undo operations are attached to a buffer, not a window.  Thus if
  104.     you have two windows to the same buffer, and make a change in one,
  105.     you can undo it in the other.
  106.  
  107. Buffer manipulation commands:  
  108. -----------------------------
  109.     _    Show a history list of the up to 9 most recently visited 
  110.         buffers.  Follow this command with a digit to select that
  111.         buffer, or simply repeat it ("__") as a synonym for "_1".
  112.         Modified buffers are preceded by a '*' in the history list.
  113.         There are many different ways to get the previous file:
  114.             __
  115.             _1
  116.             1_
  117.             :p
  118.             :e#
  119.             ^^   (ctrl-^)  (but many keyboards can't produce this)
  120.  
  121.     :e    Edit a file.  If the file is already in a buffer, that buffer
  122.         will be recalled into the current window.
  123.  
  124.     :e!    Re-edit a file.  A different filename can be given, but the 
  125.         buffer name will not change to match it. 
  126.  
  127.     ^X-e    Edit the file whose pathname appears under the cursor.  That
  128.         is, if you are editing a makefile, you could edit one of the
  129.         source files by placing the cursor at the start of its name
  130.         and using this command.
  131.  
  132.     :n    Go to the next buffer.  "next" means least recently used.
  133.  
  134.     :rename    Rename the current buffer.  Prompts for a new name.  Does
  135.         not affect the filename associated with the buffer.  Use ":f"
  136.         to do that.
  137.         This command is useful for renaming the "[Output]" buffer, if
  138.         you wish to preserve its contents, but run a new command. 
  139.  
  140.     :b    Edit a buffer.  Recalls the named buffer.  Does not look for
  141.         a file of that name.  Will find "invisible" buffers.
  142.  
  143.     :ki    Kill a buffer.  Remove the buffer and its contents from the
  144.         editor.  Will ask if changes to the buffer should be discarded.
  145.         Currently, a buffer that is being displayed cannot be killed.
  146.         
  147.     *    Display a list of all buffers, or make that display go away
  148.         if it's already present.  Leave your finger on the key, and
  149.         it's easy to create and destroy the list.  The buffers are
  150.         numbered; the numbers correspond to the history numbers
  151.         shown and used by the '_' command, described above.  (If
  152.         the buffer number is greater than 9, then the "nn_" form of
  153.         the '_' command must be used, since '_' will only accept a
  154.         single following digit.)  Note that since the buffer names
  155.         are displayed in order of use, the list can quickly grow
  156.         "stale" -- the numbers may be meaningless if buffer
  157.         switching has been done since the last display of the list. 
  158.  
  159.         The program version is also displayed with this command.
  160.  
  161.     ^A-*    Always display a list of all buffers.  Useful for updating the
  162.         list if it's already on the screen but may be out of date.
  163.         Any argument will cause the list to include _all_ buffers,
  164.         even those normally considered "invisible".  (For example,
  165.         macros are stored in "invisible" buffers.)
  166.  
  167. Window manipulation commands:  
  168. -----------------------------
  169.     ^T    Make Two windows.  Splits the current window in half. This
  170.         is the usual way to create a new window.
  171.     ^K    Get rid of (Kill) this window.
  172.     ^O    Make this the Only window on the screen.
  173.  
  174.         The emacs-style commands ^X-2, ^X-0, and ^X-1 are also 
  175.         included, and are synonymous with ^T, ^K, and ^O.
  176.  
  177.     ^N    Go to the next window on the screen.
  178.     ^P    Go to the previous window on the screen.
  179.  
  180.         These two commands may be disturbing to vi users who use
  181.         ^N and ^P to move between lines.  See the examples under
  182.         Key Rebinding for how to fix this.
  183.  
  184.     v    Make the current window smaller.
  185.     V    Make the current window larger.
  186.  
  187.     ^A-^D    Scroll the next window down half a screen.
  188.     ^A-^U    Scroll the next window up half a screen.
  189.     ^A-^E    Scroll the next window up one line.
  190.     ^A-^Y    Scroll the next window down one line.
  191.     (The previous four commands are useful when comparing two buffers.
  192.      Mnemonic -- think of them as affecting the "A"lternate window.)
  193.  
  194.     zH zM zL  These are synonyms for vi's 'z+'